IoTData

[POST] /api/v2/data/iots

创建 IoT 文档。

请求数据格式

IoTDataViewModel

返回值

状态码: 204

无内容

状态码: 400

错误的请求

CreateIoTDataResponseModel

[PUT] /api/v2/data/iots/{id}

更新IoT文档信息。

参数:

名称	类型	位置	描述
id必填项	string	path	文档编号。例如：05bb029e-0d75-dc4d-671b-87299a4a6907

请求数据格式

IoTDataViewModel

返回值

状态码: 204

无内容

状态码: 400

错误的请求

UpdateIoTDataResponseModel

[GET] /api/v2/data/iots/{id}

获取物联网文档信息。

参数:

名称	类型	位置	描述
id必填项	string	path	文档编号。例如：05bb029e-0d75-dc4d-671b-87299a4a6907

返回值

状态码: 204

无内容

状态码: 400

错误的请求

IoTDataViewModel

[GET] /api/v2/data/iots/{id}/download

下载物联网文档。

参数:

名称	类型	位置	描述
id必填项	string	path	文档编号。例如：05bb029e-0d75-dc4d-671b-87299a4a6907

返回值

状态码: 200

成功

binary

状态码: 400

错误的请求

DatasetPluginErrorV2

状态码: 404

未找到

DatasetPluginErrorV2

类型定义

Ƭ CreateIoTDataResponseModel

创建物联网文档 api 响应模型。

名称	类型	描述	示例
id可为空	string	文档编号	`"2e88e55a-e050-4924-8a69-f4ab0dcb05a6"`
message可为空	string	创建文档状态、成功或错误消息。	`"success"`

Ƭ IoTDataViewModel

物联网文档视图模型。

名称	类型	描述	示例
name可为空	string	文档名称	`"IoT_document1"`
comment可为空	string	文档注释	`"create document."`
description可为空	string	文件说明	`"It is a IoT document."`
sampleJson可为空	string	示例消息。	`"{\n\t\"deviceId\": \"device001\",\n\t\"status\": {\n\t\t\"temperature\": 25.3,\n\t\t\"online\": true\n\t}\n}"`
subsets可为空	IoTDataViewSubset	虚拟实体
connectionType	ConnectionType
uri可为空	string	HTTP 请求 URI	`"http://192.168.1.111:8080/api/device/status"`
requestMethod可为空	string	HTTP 请求方法 GET 或 POST	`"GET"`
headers可为空	WebConfigViewHeader	HTTP 请求标头
payload可为空	string	HTTP 请求正文
interval	int32	HTTP请求间隔时间；单位：毫秒，默认值：1000。	`2000`
host可为空	string	MQTT 代理或 Websocket 服务器地址。	`"192.168.1.111:1883"`
username可为空	string	认证用户名	`"username"`
password可为空	string	认证密码	`"password"`
topic可为空	string	MQTT 订阅主题	`"mqtt/topic"`
enableSSL	Boolean	启用 SSL/TLS 加密，默认值：false。
encoding可为空	string	字符集，用于解析消息。	`"utf8"`

Ƭ IoTDataViewSubset

名称	类型	描述	示例
name可为空	string	虚拟实体名称	`"VirtualEntity1"`
columns可为空	IoTDataViewColumn	虚拟实体字段

Ƭ ConnectionType

Enum:

HTTP
WebSocket
MQTT

Ƭ WebConfigViewHeader

HTTP 请求标头

名称	类型	描述	示例
key可为空	string	HTTP 请求标头密钥	`"Content-Type"`
value可为空	string	HTTP 请求标头值	`"application/json"`

Ƭ IoTDataViewColumn

名称	类型	描述	示例
name可为空	string	字段名称	`"book"`
dataType	DataType
alias可为空	string	字段别名	`"store_book"`
jsonPath可为空	string	JSONPath，json中查询字段值。	`"$.store.book"`

Ƭ DataType

Enum:

String
Number
Boolean
DateTime

Ƭ UpdateIoTDataResponseModel

更新文档响应模型

名称	类型	描述	示例
success	Boolean	更新文档响应，真或假。	`true`
message可为空	string	更新文档响应消息。	`"success"`

Ƭ DatasetPluginErrorV2

数据集插件错误模型

名称	类型	描述
code可为空	string	错误代码
message可为空	string	错误信息
context可为空	string	错误上下文
innerError	DatasetPluginErrorV2
extendedResult可为空	any	扩展结果